home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 26 / Mac Magazin and MacEasy Magazine CD - Issue 26.iso / Wissenschaft & Technik / TimGA 1.1 ƒ / Read Me (TimGA) < prev    next >
Text File  |  1996-08-17  |  12KB  |  289 lines
  1. _______________________________________________________________
  2. TimGA — A freeware Mac application
  3. Version 1.1 (August 1996)
  4.  
  5. By Timo Eloranta
  6. Copyright © 1995-96 Brown Eyes Software
  7. All rights reserved.
  8.  
  9. Internet e-mail:  timo.eloranta@ac.com    
  10. _______________________________________________________________
  11.  
  12. Contents
  13.  
  14.   •  Description
  15.     •  Thesis
  16.   •  System Requirements
  17.   •  List of Files Included
  18.   •  Quick Instructions
  19.   •  Known Weaknesses
  20.   •  Version History
  21.   •  Credits & Acknowledgments
  22.   •  Distribution
  23.   •  Fine Print
  24.     •  One More Disclaimer...
  25.   •  Contacting the Author
  26.  
  27.  
  28. Description
  29.  
  30. Given a graph — a bunch of nodes and edges that is — TimGA tries to draw
  31. it as "nicely" as possible by minimizing edge crossings among other things.
  32. The key feature of TimGA is its use of a genetic algorithm (GA).
  33.   
  34. It is unlikely that anyone (except for myself) will find TimGA useful,
  35. but if you're interested in graph drawing and/or genetic algorithms you'll
  36. stand a good chance of finding TimGA interesting. Screensaver enthusiasts
  37. might also get a kick out of watching those drawings develop — maybe
  38. kids as well...
  39.  
  40.  
  41. Thesis
  42.  
  43. TimGA was the side product of my Master's thesis which handles — not
  44. too surprisingly — the use of genetic algorithms for drawing graphs. The 
  45. actual thesis — "Geneettisten algoritmien soveltaminen
  46. suuntaamattomien verkkojen piirtoon" — is available by request
  47. from the University of Tampere  (ask for it from Erkki Mäkinen,
  48. em@cs.uta.fi), but it's unfortunately written in Finnish...
  49.  
  50. The good news is that there's also an article length English version
  51. ("TimGA — A Genetic Algorithm For Drawing Undirected Graphs"),
  52. which has been submitted for publication in the International Journal of
  53. Computer Mathematics. For a copy of this article contact the above
  54. mentioned Mr. Mäkinen.
  55.  
  56.   
  57. System Requirements
  58.  
  59.   •  a Mac equipped with a 68020 or greater CPU
  60.       (a 68040 or a PowerPC is highly recommended...)
  61.   •  MacOS 7.0 or later
  62.   •  about 1 MB of free RAM
  63.   •  13" or larger (640x480 or larger) monitor
  64.   •  ObjectSupportLib (only PowerMacs need this)
  65.  
  66.   •  Note: TimGA is a "fat binary" and runs entirely in native PowerPC
  67.       code if you have a PowerMacintosh (or compatible) !
  68.  
  69.  
  70. List of Files Included
  71.  
  72. You should  have received TimGA with the following files and folders:
  73.  
  74.     •    TimGA 1.1
  75.       =  The application itself
  76.  
  77.   •  ReadMe (TimGA)
  78.       =  This file
  79.  
  80.     •  "Graphs" folder (with subfolders)
  81.       =  30+ example graph files. These are in the format that TimGA
  82.           understands. Note though that TimGA is in no way restricted to
  83.           just these graphs. You can create new graphs yourself (read the
  84.           instructions in the "More Documentation" folder) or let TimGA
  85.           create random new graphs with the "Rnd New Graph..." command.
  86.           FYI, the "Small" graphs have 14-32 edges, the "Bigger" ones
  87.           up to 84 edges and the "Heavyweight" graphs (128-276 edges)
  88.           should only be tried by PowerMac owners or people who enjoy
  89.           waiting...
  90.  
  91.   •  "Picts" folder
  92.       =  A small selection of drawings produced by TimGA (in PICT format).
  93.           These files can NOT be opened by TimGA, but instead with Apple's
  94.           own SimpleText or just about any graphics program (I recommend
  95.           watching these with Aaron Giles' JPEGView in "Slide Show" mode).
  96.           Note that TimGA 1.1 does not have a Save command, but you can copy
  97.           the drawings to the clipboard with the Copy command and then paste
  98.           to any graphics capable program. Alternatively you can capture
  99.           drawings with the command-shift-3 snapshot command which 
  100.           is part of the MacOS.
  101.  
  102.     •  "More Documentation" folder
  103.       =  For descriptions of the various menus & dialogs read the file 
  104.          "Help (TimGA)". If you'd like to write some graph files yourself
  105.          please see the instructions in the file titled "Writing graph files".
  106.   
  107.  
  108. Quick Instructions
  109.  
  110. It doesn't take many steps to put TimGA to work! Here goes...
  111.  
  112.   •  Launch the application by double-clicking the icon of the application.
  113.   •  Now choose either "Open Graph..." or "Rnd New Graph..." 
  114.       from the "File" menu.
  115.       •  If you chose to open an existing graph, select one of the graph files
  116.           in the "Graphs" folder. I recommend that you start with one of the
  117.           files in the "(1) Small graphs" subfolder.
  118.       •  If you chose to try a random graph, TimGA will ask for the quantity
  119.           of nodes and edges. When you're ready, click the OK button.
  120.   •  At this point you might want to set the termination condition(s) for the
  121.       the iteration. It's not obligatory, but if you want, you can do this 
  122.       with the "Termination..." command in the "Settings" menu.
  123.   •  Start the action by selecting "Start" from the "Iteration" menu.
  124.  
  125. TimGA now tries to draw the graph as nicely as possible. The iteration
  126. stops when one of the termination conditions you've set is filled or when
  127. you select "Pause" from the "Iteration" menu. You can try the same
  128. graph again by "rewinding" the iteration with the "Reinitialize" command.
  129. An interesting feature of TimGA is that the resulting drawings differ from
  130. run to run! It's like a box of chocolates, you never know what you get...
  131.  
  132. Note: To change the size of the drawing grid (the default is 40x40) you
  133. should choose "General..." from the "Settings" menu. Unfortunately
  134. the current version of TimGA does not allow access to this menu item
  135. when there's an "open" graph. The graph must first be closed with the
  136. "Close Graph" command in the "File" menu. Sorry about this!
  137.  
  138. To learn about the rest of the menu items and the various fields in the
  139. main display read the "Help (TimGA)" file or investigate yourself...
  140.  
  141.  
  142. Known Weaknesses
  143.  
  144. TimGA 1.0 was released almost eight months ago and I haven't yet received
  145. a single bug report. So, TimGA should be stable enough (no cash prices for
  146. finding bugs though!), but it still has plenty of weaknesses and missing
  147. features. Here are the "highlights":
  148.  
  149.   •    I know it's slow — especially on 680x0 Macs and/or when drawing big
  150.       graphs. But hey, give me some credit! The problem of writing a program
  151.       for drawing any kind of graph "nicely" is a rather difficult one...
  152.  
  153.   •  The program has no saving. More specifically, you cannot save the state
  154.       of iteration (to be continued later) or the produced drawings, and your
  155.       settings are not saved to a prefs file. To make the list perfect, there's
  156.       no printing either! And what is my excuse? Well, TimGA is an
  157.       "academic toy". If the program would have "real users", all of these
  158.       lacking features could/should be added.
  159.  
  160.       >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
  161.       Version 1.1 fixes some of the problems in this area by allowing you to
  162.       copy your drawings to the clipboard. You can then paste the pictures
  163.       to any printing capable graphics or word processing program.
  164.       <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  165.  
  166.   •  Entering your own graphs should be made easier. Currently this is done
  167.       by writing a "graph file" with a text editor (if interested, read the
  168.       file titled "Writing graph files"), but a simple graph editor with
  169.       graphical user interface would of course be much better.
  170.  
  171.   •  The thing with General Settings which I mentioned above in the "Quick
  172.       Instructions" section. I won't bore you with the reason that's causing
  173.       it. I'll probably fix this "feature" if I get enough complaints...
  174.  
  175.   •  There's no balloon help (actually there is ONE balloon...) or an Apple
  176.       Guide. Adding these is pretty low on my list of things to do...
  177.  
  178. I'm sure these are not the only weaknesses of TimGA. If you have some other
  179. ideas for improving this program, I'd be interested in hearing them!
  180.  
  181.         
  182. Version History
  183.  
  184. 1.1           17 August 1996
  185.                         •    First public release with the new features of 1.0.2 
  186.                       (copy command, grid scaling and the b&w mode).
  187.                         •    Updated the documentation (new contact info etc.)
  188.  
  189. 1.0.2        06 May 1996 (never released to general public)
  190.                         •    Added support for the clipboard (copy command!).
  191.                         •    Added a sort of zooming. You can now manually (and without even
  192.                       pausing the iteration...) change the grid square size, which affects
  193.                       the size of the drawing.
  194.                         •    Added support for a b&w mode, which I personally prefer when
  195.                       copying pictures to clipboard and then printing them with another app.
  196.                         •    Fixed a bug (introduced by version 1.0.1) which caused a crash on
  197.                       68K Macs when opening a graph file where the graph had >256 edges...
  198.                         •    Removed the job hunt notice from documentation (but you can still
  199.                       offer me Mac development related positions if you want...).
  200.                       
  201. 1.0.1        21 Feb 1996
  202.                         •    Many optimizations. With small graphs the iteration speed is now
  203.                       roughly 155% faster than with version 1.0. With big graphs
  204.                       (over 100 edges) the improvement is "only" around 45%.
  205.               •    Added notes about the Termination dialog to the documentation.
  206.  
  207. 1.0         22 Dec 1995
  208.               •    Initial public release.
  209.  
  210.  
  211. Credits & Acknowledgments
  212.  
  213.   •  First of all, my thanks to Erkki Mäkinen, who introduced me to the world
  214.       of genetic algorithms and suggested the topic of my Master's thesis.
  215.  
  216.   •  For risking their Macs and giving loads of useful comments and 
  217.       suggestions I'd like to thank my international beta-testing crew:
  218.  
  219.       Eric Allen, Leo Breebaart, Tilman Brodmeier, 
  220.       Juha Herajärvi, Martin Krueger, Miika Matilainen, 
  221.       Michael Mitchener, Arne Schirmacher and Javier Sisamón.
  222.  
  223.   •  Special thanks to fellow programmers who have released source code,
  224.       libraries and PowerPlant classes for others to use and learn from. TimGA
  225.       benefits from the following such libraries and PP classes:
  226.  
  227.       •  STL by Hewlett-Packard Company
  228.           Info available from http://www.cs.rpi.edu/~musser/stl.html
  229.  
  230.       •  LProgressIndicator by Chris K. Thomas (ckt@best.com) 
  231.       •  Slider by Scott Squires (squires@crl.com)
  232.  
  233.           LProgressIndicator and Slider are both available from
  234.           the PowerPlant Contributed Class Archive at
  235.           ftp://atlantis.metrowerks.com/pub/powerplant/
  236.  
  237.   •  TimGA 1.1 was created using CodeWarrior 9 (by Metrowerks) and 
  238.       ResEdit 2.1.3 (by Apple). I highly recommend the PowerPlant 
  239.       framework which is part of the CodeWarrior package.  
  240.  
  241.   •  Folder icons were made with Folder Icon Maker 1.5 by Greg Robbins.
  242.   
  243.   
  244. Distribution  
  245.  
  246. TimGA is freeware, which means that you can use the program for free
  247. but that I still retain the copyright. More specifically, this program cannot
  248. be sold for a profit or distributed thru a commercial channel 
  249. without my written consent. Distribution via online services, BBS's,
  250. Internet, person-to-person and other non-commercial means is acceptable
  251. provided that all original and unaltered files are included in the package. 
  252.  
  253.  
  254. Fine Print
  255.  
  256. [  Like I said, TimGA should be very stable, but here comes the boring
  257.    stuff anyway...  ]
  258.  
  259. TimGA is supplied "as is". The author makes no warranties, either express
  260. or implied, and will not be liable for any special, incidental, consequential
  261. or indirect damages, including but not limited to loss of data or psychological
  262. damage. The person using this software bears all risk as to its quality and
  263. performance. By using this software, you are subject and agree to the terms
  264. in this disclaimer. In short, use TimGA at your own risk.
  265.  
  266.  
  267. One More Disclaimer...
  268.  
  269. My current employer, which some of you might guess from my e-mail address,
  270. has absolutely _nothing_ to do with TimGA or other freeware programs
  271. which I've released under the title of Brown Eyes Software. Clear enough ?
  272.  
  273.  
  274. Contacting the Author
  275.  
  276. For questions, praise, bug reports (oh no!), comments and job offers, I can be
  277. reached via Internet e-mail at
  278.  
  279.   timo.eloranta@ac.com
  280.  
  281. or by "snail mail" (postcards would be greatly appreciated!) at
  282.  
  283.   Timo Eloranta
  284.   Vänrikki Stoolin katu 10B A2
  285.   FIN-00100 Helsinki
  286.   Finland (Europe)
  287.  
  288. _______________________________________________________________
  289.